home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / misc / wangipad.lha / WangiPad / cx_desc.doc next >
Encoding:
Text File  |  1995-01-04  |  3.4 KB  |  132 lines
  1.                         Input Description Strings
  2.                         =========================
  3.                         
  4. Description
  5. ===========
  6.  
  7.    The following regular expression outlines the format of the input 
  8. description string as used in hotkeys:
  9.  
  10.    [class] {[-](qualifier|synonym)} [[-]upstroke] [highmap|ANSICode]
  11.    
  12.    Class can be any one of the class strings given below. Commodities will
  13. assume that the class is rawkey if the class is not explicitly stated.
  14.  
  15.    rawkey
  16.    rawmouse
  17.    event
  18.    pointerpos
  19.    timer
  20.    newprefs
  21.    diskremoved
  22.    diskinserted
  23.    
  24.    Qualifier is one of the qualifier strings from the table below. A dash
  25. preceding the qualifier string tells commodities not to care if that 
  26. qualifier is present. Note that there can be one or more qualifier (or none
  27. at all) in the input description string. The qualifiers in the lefthand 
  28. list can be used on all Workbench versions from 2.0, the righthand list only
  29. if you are using greater than Workbench 2.1
  30.  
  31.    Workbench > 2.0                Workbench > 2.1
  32.    
  33.    lcommand                       left_command, lamiga, left_amiga
  34.    rcommand                       right_command, ramiga, right_amiga
  35.    lshift                         left_shift
  36.    rshift                         right_shift
  37.    lalt                           left_alt
  38.    ralt                           right_alt
  39.    capslock                       caps_lock
  40.    control                        ctrl
  41.    numericpad                     numericpad, numpad, num_pad
  42.    lbutton                        left_button
  43.    midbutton                      mbutton, middlebutton, middle_button
  44.    rbutton                        rightbutton, right_button
  45.    relativemouse
  46.    repeat
  47.    
  48.    
  49.    Synonym is one of the synonym strings from the table below. The strings 
  50. act as synonyms for groups of qualifiers. A dash preceding the synonym string 
  51. tells commodities not to care if that synonym is present. Note that there can 
  52. be one or more synonyms (or none at all) in the input description string. 
  53.  
  54.    shift
  55.    caps
  56.    alt
  57.    
  58.    Several more synonyms were added in Workbench 2.1:
  59.    
  60.    backspace
  61.    f1..f12
  62.    break
  63.    help
  64.    comma
  65.    home
  66.    down
  67.    cursor_down
  68.    insert
  69.    left
  70.    cursor_left
  71.    page_down
  72.    right
  73.    cursor_right
  74.    page_up 
  75.    up
  76.    cursor_up
  77.    pause
  78.    del, delete
  79.    return
  80.    end
  81.    space, spacebar
  82.    enter
  83.    tab
  84.    esc, escape
  85.    
  86.    Upstroke is the literal string "upstroke". If this string is absent, 
  87. commodities only considers upstrokes. If it is present alone then only 
  88. upstrokes are considered. If preceded by a dash then both upstrokes and 
  89. downstrokes are considered.
  90.  
  91.    Highmap is one of the following:
  92.    
  93.    space
  94.    backspace
  95.    tab
  96.    enter
  97.    return
  98.    esc
  99.    del
  100.    up
  101.    down
  102.    right
  103.    left
  104.    help
  105.    f1..f12
  106.    
  107.    ANSICode is a single character (eg 'a'). For class rawmouse the following 
  108. are available with Workbench 2.1 or greater:
  109.  
  110.    mouse_leftpress
  111.    mouse_middlepress
  112.    mouse_rightpress 
  113.    
  114. Examples
  115. ========
  116.  
  117.    "rawkey lshift alt f2" - Function key F2 with left shift and either alt
  118.    key pressed.
  119.    
  120.    "rawkey numericpad *" - The asterix key on the numeric pad.
  121.    
  122.    "rawmouse mouse_middlepress" - (WB 2.1++) The middle mouse button.
  123.    
  124. Info
  125. ====
  126.  
  127.    This document helps to describe a feature that should have been covered 
  128. in the system manuals. It has been put together from various Commodore 
  129. developer material. You are free to distribute this document with your own
  130. programs, providing credit is given.
  131.  
  132.    Lee Kindness